0.3.0 - Second STU ballot

This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: ReferralRequestSTU3

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-referralrequest-stu3

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ReferralRequest

Summary

Mandatory: 8 elements
Must-Support: 14 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest I0..*A request for referral or transfer of care
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-insurance SI0..*Reference(CoverageSTU3)Insurance
URL: http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier
... definition SΣ1..1Reference(ActivityDefinition | PlanDefinition)Instantiates protocol or definition
... basedOn SΣ1..1Reference(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-ReferralRequest-stu3 | ProcedureRequestSTU3)Request fulfilled by this request
... replaces Σ0..*Reference(ReferralRequest)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
Fixed Value: draft
... intent ?!Σ1..1codeproposal | plan | order
Binding: RequestIntent (required)
... type Σ0..1CodeableConceptReferral/Transition of care request type
Binding: SNOMED CT Patient Referral (example)
... priority Σ0..1codeUrgency of referral / transfer of care request
Binding: RequestPriority (required)
... serviceRequested SΣ1..1CodeableConceptActions requested as part of the referral
Binding: Practice Setting Code Value Set (example)
... subject SΣ1..1Reference(PatientSTU3)Patient referred to care or transfer
... context Σ0..1Reference(EncounterSTU3)Originating encounter
... occurrence[x] SΣ0..1dateTime, PeriodWhen the service(s) requested in the referral should occur
... authoredOn SΣ1..1dateTimeDate of creation/activation
... requester SΣI1..1BackboneElementWho/what is requesting service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent SΣ1..1Reference(PractitionerSTU3)Individual making the request
.... onBehalfOf ΣI0..1Reference(Organization)Organization agent is acting for
... specialty 0..1CodeableConceptThe clinical specialty (discipline) that the referral is requested for
Binding: PractitionerSpecialty (example)
... recipient SΣ0..*Reference(PractitionerSTU3)Receiver of referral / transfer of care request
... reasonCode SΣ0..*CodeableConceptReason for referral / transfer of care request
Binding: SNOMED CT Clinical Findings (example)
... reasonReference SΣ0..*Reference(US Core Condition Profile | US Core Result Observation)Why is service needed?
... description 0..1stringA textual description of the referral
... supportingInfo 0..*Reference(Resource)Additonal information to support referral or transfer of care request
... note 0..*AnnotationComments made about referral request
... relevantHistory 0..*Reference(Provenance)Key events in history of request

doco Documentation for this format

This structure is derived from ReferralRequest

Summary

Mandatory: 8 elements
Must-Support: 14 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest I0..*A request for referral or transfer of care
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-insurance SI0..*Reference(CoverageSTU3)Insurance
URL: http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier
... definition SΣ1..1Reference(ActivityDefinition | PlanDefinition)Instantiates protocol or definition
... basedOn SΣ1..1Reference(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-ReferralRequest-stu3 | ProcedureRequestSTU3)Request fulfilled by this request
... replaces Σ0..*Reference(ReferralRequest)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
Fixed Value: draft
... intent ?!Σ1..1codeproposal | plan | order
Binding: RequestIntent (required)
... type Σ0..1CodeableConceptReferral/Transition of care request type
Binding: SNOMED CT Patient Referral (example)
... priority Σ0..1codeUrgency of referral / transfer of care request
Binding: RequestPriority (required)
... serviceRequested SΣ1..1CodeableConceptActions requested as part of the referral
Binding: Practice Setting Code Value Set (example)
... subject SΣ1..1Reference(PatientSTU3)Patient referred to care or transfer
... context Σ0..1Reference(EncounterSTU3)Originating encounter
... occurrence[x] SΣ0..1dateTime, PeriodWhen the service(s) requested in the referral should occur
... authoredOn SΣ1..1dateTimeDate of creation/activation
... requester SΣI1..1BackboneElementWho/what is requesting service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent SΣ1..1Reference(PractitionerSTU3)Individual making the request
.... onBehalfOf ΣI0..1Reference(Organization)Organization agent is acting for
... specialty 0..1CodeableConceptThe clinical specialty (discipline) that the referral is requested for
Binding: PractitionerSpecialty (example)
... recipient SΣ0..*Reference(PractitionerSTU3)Receiver of referral / transfer of care request
... reasonCode SΣ0..*CodeableConceptReason for referral / transfer of care request
Binding: SNOMED CT Clinical Findings (example)
... reasonReference SΣ0..*Reference(US Core Condition Profile | US Core Result Observation)Why is service needed?
... description 0..1stringA textual description of the referral
... supportingInfo 0..*Reference(Resource)Additonal information to support referral or transfer of care request
... note 0..*AnnotationComments made about referral request
... relevantHistory 0..*Reference(Provenance)Key events in history of request

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
ReferralRequest.statusrequiredFixed Value: draft
ReferralRequest.serviceRequestedexamplePractice Setting Code Value Set
ReferralRequest.reasonCodeexampleSNOMED CT Clinical Findings

Constraints

IdPathDetailsRequirements
dom-2ReferralRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ReferralRequestIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ReferralRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3ReferralRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1ReferralRequest.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ReferralRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ReferralRequest.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ReferralRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ReferralRequest.requesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
rfr-1ReferralRequest.requesteronBehalfOf can only be specified if agent is practitioner or device
: (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()